Improved fqtk demux --help output readability
#45
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- added clap directive to print doc string verbatim - annotated code as bash to prevent `cargo doc` expecting rust code
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I looked into parsing MarkDown in Rust for terminal output, and the two options that might make sense are
pulldown-cmark-mdcatandtermimad.However, since the help text is in a documentation string (currently parsed and added to
--helpbyclap), I decided not to add a dependency and move things around. It looks like it may be a while before clap adds MarkDown support (clap-rs/clap#2389), but a simple single-line workaround fixes the newline issue around Markdown lists and code, which IMO was the main readability issue.